Management API

Base Resource URL:


                    https://[server-name]/api/v01/merchants/[merchant-code]/profiles/cards-realtime/firstdata-compass

Description:

Settings for processing of debit and credit cards in realtime mode through FirstData Compass On-Line platform.

Supported Actions:

activate

Method: GET	Implicit: No	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Registers and Activates Datawire ID with First Data Secure Transport. This step is necessary for all new account setups on First Data Compass. Registration and activation is only necessary once.

copyFrom

Method: GET	Implicit: No	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Copies profile settings from another merchant's profile definition.

copyTo

Method: GET	Implicit: No	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Copies profile settings of the selected merchant into corresponding profile settings of the specified merchants/sub-merchants.

delete

Method: DELETE	Implicit: Yes	Returns: ServiceResponse
Consumes: xurl		Produces: json, xml

Deletes profile settings.

load

Method: GET	Implicit: Yes	Returns: FirstDataCompassCardsRealtimeProviderProfile *
Consumes: xurl		Produces: json, xml

Returns current profile settings.

modify

Method: POST	Implicit: Yes	Returns: FirstDataCompassCardsRealtimeProviderProfile *
Consumes: json, xml, xurl		Produces: json, xml

Creates new or updates an existing Provider Profile for real-time FirstData Compass processing.

Parameters:

#	Name	Type	Required	Default	Description
01	profile	FirstDataCompassCardsRealtimeProviderProfile *	Yes		Updated profile information. Configuration settings for Cards Realtime processing through FirstdataCompass